MapSnapshotterInterface

interface MapSnapshotterInterface : CameraManagerInterface

MapSnapshotter exposes functionality to capture static map images.

Functions

addPersistentStyleCustomLayer

abstract fun addPersistentStyleCustomLayer(@NonNull() layerId: String, @NonNull() layerHost: CustomLayerHost, @Nullable() layerPosition: LayerPosition): Expected<String, None>

Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).Note: This is an experimental API and is a subject to change.Whenever a new style is being parsed and currently used style has persistent layers,an engine will try to do following:- keep the persistent layer at its relative position- keep the source used by a persistent layer- keep images added through `addStyleImage` methodIn cases when a new style has the same layer, source or image resource, style's resources would beused instead and `MapLoadingError` event will be emitted.

addPersistentStyleLayer

abstract fun addPersistentStyleLayer(@NonNull() properties: Value, @Nullable() layerPosition: LayerPosition): Expected<String, None>

Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).Note: This is an experimental API and is a subject to change.Whenever a new style is being parsed and currently used style has persistent layers,an engine will try to do following:- keep the persistent layer at its relative position- keep the source used by a persistent layer- keep images added through `addStyleImage` methodIn cases when a new style has the same layer, source or image resource, style's resources would beused instead and `MapLoadingError` event will be emitted.

addStyleCustomGeometrySource

abstract fun addStyleCustomGeometrySource(@NonNull() sourceId: String, @NonNull() options: CustomGeometrySourceOptions): Expected<String, None>

Adds a custom geometry to be used in the style.

addStyleCustomLayer

abstract fun addStyleCustomLayer(@NonNull() layerId: String, @NonNull() layerHost: CustomLayerHost, @Nullable() layerPosition: LayerPosition): Expected<String, None>

Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).Runtime style layers are valid until they are either removed or a new style is loaded.

addStyleImage

abstract fun addStyleImage(@NonNull() imageId: String, scale: Float, @NonNull() image: Image, sdf: Boolean, @NonNull() stretchX: List<ImageStretches>, @NonNull() stretchY: List<ImageStretches>, @Nullable() content: ImageContent): Expected<String, None>

Adds an image to be used in the style.

addStyleLayer

abstract fun addStyleLayer(@NonNull() properties: Value, @Nullable() layerPosition: LayerPosition): Expected<String, None>

Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).Runtime style layers are valid until they are either removed or a new style is loaded.

addStyleSource

abstract fun addStyleSource(@NonNull() sourceId: String, @NonNull() properties: Value): Expected<String, None>

Adds a new [style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources).

cameraForCoordinateBounds

abstract fun cameraForCoordinateBounds(@NonNull() bounds: CoordinateBounds, @NonNull() padding: EdgeInsets, @Nullable() bearing: Double, @Nullable() pitch: Double): CameraOptions

Convenience method that returns the `camera options` object for given parameters.

cameraForCoordinates

abstract fun cameraForCoordinates(@NonNull() coordinates: List<Point>, @NonNull() camera: CameraOptions, @NonNull() box: ScreenBox): CameraOptions

Convenience method that adjusts the provided `camera options` object for given parameters.Returns the provided `camera` options with zoom adjusted to fit `coordinates` into the `box`, so that `coordinates` on the left,top and right of the effective `camera` center at the principal point of the projection (defined by `padding`) fit into the `box`.Returns the provided `camera` options object unchanged upon an error.Note that this method may fail if the principal point of the projection is not inside the `box` orif there is no sufficient screen space, defined by principal point and the `box`, to fit the geometry.

abstract fun cameraForCoordinates(@NonNull() coordinates: List<Point>, @NonNull() padding: EdgeInsets, @Nullable() bearing: Double, @Nullable() pitch: Double): CameraOptions

Convenience method that returns the `camera options` object for given parameters.

cameraForGeometry

abstract fun cameraForGeometry(@NonNull() geometry: Geometry, @NonNull() padding: EdgeInsets, @Nullable() bearing: Double, @Nullable() pitch: Double): CameraOptions

Convenience method that returns the `camera options` object for given parameters.

cancel

abstract fun cancel()

Cancel the current snapshot operation.Cancel the current snapshot operation, if any.

coordinateBoundsForCamera

abstract fun coordinateBoundsForCamera(@NonNull() camera: CameraOptions): CoordinateBounds

Returns the `coordinate bounds` for a given camera.Note that if the given `camera` shows the antimeridian, the returned wrapped `coordinate bounds`might not represent the minimum bounding box.

coordinateBoundsZoomForCamera

abstract fun coordinateBoundsZoomForCamera(@NonNull() camera: CameraOptions): CoordinateBoundsZoom

Returns the `coordinate bounds` and the `zoom` for a given `camera`.Note that if the given `camera` shows the antimeridian, the returned wrapped `coordinate bounds`might not represent the minimum bounding box.

coordinateBoundsZoomForCameraUnwrapped

abstract fun coordinateBoundsZoomForCameraUnwrapped(@NonNull() camera: CameraOptions): CoordinateBoundsZoom

Returns the unwrapped `coordinate bounds` and `zoom` for a given `camera`.This method is particularly useful, if the `camera` shows the antimeridian.

coordinateForPixel

abstract fun coordinateForPixel(@NonNull() pixel: ScreenCoordinate): Point

Calculates a geographical `coordinate` (i.e., longitude-latitude pair) that correspondsto a `screen coordinate`.The screen coordinate is in `platform pixels`relative to the top left cornerof the map (not of the whole screen).

coordinatesForPixels

abstract fun coordinatesForPixels(@NonNull() pixels: List<ScreenCoordinate>): List<Point>

Calculates geographical `coordinates` (i.e., longitude-latitude pairs) that correspondto `screen coordinates`.The screen coordinates are in `platform pixels` relative to the top left cornerof the map (not of the whole screen).

dragEnd

abstract fun dragEnd()

Ends the ongoing drag gesture.

dragStart

abstract fun dragStart(@NonNull() point: ScreenCoordinate)

Prepares the drag gesture to use the provided screen coordinate as a pivot `point`.

getBounds

abstract fun getBounds(): CameraBounds

Returns the `camera bounds` of the map.

getCameraState

abstract fun getCameraState(): CameraState

Returns the current `camera state`.

getDragCameraOptions

abstract fun getDragCameraOptions(@NonNull() fromPoint: ScreenCoordinate, @NonNull() toPoint: ScreenCoordinate): CameraOptions

Calculates target point where camera should move after drag.

getElevation

abstract fun getElevation(@NonNull() coordinate: Point): Double

Get elevation for the given coordinate.Note: Elevation is only available for the visible region on the screen.

getFreeCameraOptions

abstract fun getFreeCameraOptions(): FreeCameraOptions

Gets the map's current free camera options.

getMapProjection

abstract fun getMapProjection(): Value

Returns the currently active map projection and its properties as key-value pairs.Common properties shared by all map projections are:- "name" with possible values "mercator" or "globe".

getSize

abstract fun getSize(): Size

Gets the size of the snapshot

getStyleDefaultCamera

abstract fun getStyleDefaultCamera(): CameraOptions

Returns the map style's default camera, if any, or a default camera otherwise.The map style's default camera is defined as follows:- [center](https://docs.mapbox.com/mapbox-gl-js/style-spec/#root-center)- [zoom](https://docs.mapbox.com/mapbox-gl-js/style-spec/#root-zoom)- [bearing](https://docs.mapbox.com/mapbox-gl-js/style-spec/#root-bearing)- [pitch](https://docs.mapbox.com/mapbox-gl-js/style-spec/#root-pitch)The style default camera is re-evaluated when a new style is loaded.

getStyleImage

abstract fun getStyleImage(@NonNull() imageId: String): Image

Get an `image` from the style.

getStyleJSON

abstract fun getStyleJSON(): String

Get the JSON serialization string of the current style in use.

getStyleLayerProperties

abstract fun getStyleLayerProperties(@NonNull() layerId: String): Expected<String, Value>

Gets style layer properties.

getStyleLayerProperty

abstract fun getStyleLayerProperty(@NonNull() layerId: String, @NonNull() property: String): StylePropertyValue

Gets the value of style layer property.

getStyleLayers

abstract fun getStyleLayers(): List<StyleObjectInfo>

Returns the existing style layers.

getStyleLightProperty

abstract fun getStyleLightProperty(@NonNull() property: String): StylePropertyValue

Gets the value of a style light property.

getStyleSourceProperties

abstract fun getStyleSourceProperties(@NonNull() sourceId: String): Expected<String, Value>

Gets style source properties.

getStyleSourceProperty

abstract fun getStyleSourceProperty(@NonNull() sourceId: String, @NonNull() property: String): StylePropertyValue

Gets the value of style source property.

getStyleSources

abstract fun getStyleSources(): List<StyleObjectInfo>

Returns the existing style sources.

getStyleTerrainProperty

abstract fun getStyleTerrainProperty(@NonNull() property: String): StylePropertyValue

Gets the value of a style terrain property.

getStyleTransition

abstract fun getStyleTransition(): TransitionOptions

Returns the map style's transition options.

getStyleURI

abstract fun getStyleURI(): String

Get the URI of the current style in use.

invalidateStyleCustomGeometrySourceRegion

abstract fun invalidateStyleCustomGeometrySourceRegion(@NonNull() sourceId: String, @NonNull() bounds: CoordinateBounds): Expected<String, None>

Invalidate region for provided custom geometry source.

invalidateStyleCustomGeometrySourceTile

abstract fun invalidateStyleCustomGeometrySourceTile(@NonNull() sourceId: String, @NonNull() tileId: CanonicalTileID): Expected<String, None>

Invalidate tile for provided custom geometry source.

isInTileMode

abstract fun isInTileMode(): Boolean

Returns `true` if the snapshotter is in the tile mode.

isStyleLayerPersistent

abstract fun isStyleLayerPersistent(@NonNull() layerId: String): Expected<String, Boolean>

Checks if a style layer is persistent.Note: This is an experimental API and is a subject to change.

isStyleLoaded

abstract fun isStyleLoaded(): Boolean

Check if the style is completely loaded.Note: The style specified sprite would be marked as loaded even with sprite loading error (An error will be emitted via `MapLoadingError`).Sprite loading error is not fatal and we don't want it to block the map rendering, thus the function will still return `true` if style and sources are fully loaded.

moveStyleLayer

abstract fun moveStyleLayer(@NonNull() layerId: String, @Nullable() layerPosition: LayerPosition): Expected<String, None>

Moves an existing style layer

pixelForCoordinate

abstract fun pixelForCoordinate(@NonNull() coordinate: Point): ScreenCoordinate

Calculates a `screen coordinate` that corresponds to a geographical coordinate(i.e., longitude-latitude pair).The `screen coordinate` is in `platform pixels` relative to the top left cornerof the map (not of the whole screen).

pixelsForCoordinates

abstract fun pixelsForCoordinates(@NonNull() coordinates: List<Point>): List<ScreenCoordinate>

Calculates `screen coordinates` that correspond to geographical `coordinates`(i.e., longitude-latitude pairs).The `screen coordinates` are in `platform pixels` relative to the top left cornerof the map (not of the whole screen).

removeStyleImage

abstract fun removeStyleImage(@NonNull() imageId: String): Expected<String, None>

Removes an image from the style.

removeStyleLayer

abstract fun removeStyleLayer(@NonNull() layerId: String): Expected<String, None>

Removes an existing style layer.

removeStyleSource

abstract fun removeStyleSource(@NonNull() sourceId: String): Expected<String, None>

Removes an existing style source.

setBounds

abstract fun setBounds(@NonNull() options: CameraBoundsOptions): Expected<String, None>

Sets the `camera bounds options` of the map.

setCamera

abstract fun setCamera(@NonNull() cameraOptions: CameraOptions)

Changes the map view by any combination of center, zoom, bearing, and pitch, without an animated transition.The map will retain its current values for any details not passed via the camera options argument.It is not guaranteed that the provided `camera options` will be set, the map may apply constraints resulting in adifferent `camera state`.

abstract fun setCamera(@NonNull() freeCameraOptions: FreeCameraOptions)

Sets the map view with the free camera options.The `free camera options` provides more direct access to the underlying camera entity.For backwards compatibility the state set using this API must be representable with`camera options` as well.

setMapProjection

abstract fun setMapProjection(@NonNull() projection: Value): Expected<String, None>

Updates the active map projection.

setSize

abstract fun setSize(@NonNull() size: Size)

Sets the `size` of the snapshot

setStyleCustomGeometrySourceTileData

abstract fun setStyleCustomGeometrySourceTileData(@NonNull() sourceId: String, @NonNull() tileId: CanonicalTileID, @NonNull() featureCollection: List<Feature>): Expected<String, None>

Set tile data of a custom geometry.

setStyleJSON

abstract fun setStyleJSON(@NonNull() json: String)

Load the style from a provided JSON string.

setStyleLayerProperties

abstract fun setStyleLayerProperties(@NonNull() layerId: String, @NonNull() properties: Value): Expected<String, None>

Sets style layer properties.This method can be used to perform batch update for a style layer properties.

setStyleLayerProperty

abstract fun setStyleLayerProperty(@NonNull() layerId: String, @NonNull() property: String, @NonNull() value: Value): Expected<String, None>

Sets a value to a style layer property.

setStyleLight

abstract fun setStyleLight(@NonNull() properties: Value): Expected<String, None>

Sets the style global [light](https://docs.mapbox.com/mapbox-gl-js/style-spec/#light) properties.

setStyleLightProperty

abstract fun setStyleLightProperty(@NonNull() property: String, @NonNull() value: Value): Expected<String, None>

Sets a value to the the style light property.

setStyleSourceProperties

abstract fun setStyleSourceProperties(@NonNull() sourceId: String, @NonNull() properties: Value): Expected<String, None>

Sets style source properties.This method can be used to perform batch update for a style source properties.

setStyleSourceProperty

abstract fun setStyleSourceProperty(@NonNull() sourceId: String, @NonNull() property: String, @NonNull() value: Value): Expected<String, None>

Sets a value to a style source property.Note: When setting the `data` property of a `geojson` source, this method never returns an error.In case of success, a `map-loaded` event will be propagated.

setStyleTerrain

abstract fun setStyleTerrain(@NonNull() properties: Value): Expected<String, None>

Sets the style global [terrain](https://docs.mapbox.com/mapbox-gl-js/style-spec/#terrain) properties.

setStyleTerrainProperty

abstract fun setStyleTerrainProperty(@NonNull() property: String, @NonNull() value: Value): Expected<String, None>

Sets a value to the the style terrain property.

setStyleTransition

abstract fun setStyleTransition(@NonNull() transitionOptions: TransitionOptions)

Overrides the map style's transition options with user-provided options.The style transition is re-evaluated when a new style is loaded.

setStyleURI

abstract fun setStyleURI(@NonNull() uri: String)

Load style from provided URI.This is an asynchronous call.

setTileMode

abstract fun setTileMode(set: Boolean)

Sets the snapshotter to the tile mode.In the tile mode, the snapshotter fetches the still image of a single tile.

start

abstract fun start(@NonNull() callback: SnapshotCompleteCallback)

Start the rendering of a snapshot.Request that a new snapshot be rendered.

styleLayerExists

abstract fun styleLayerExists(@NonNull() layerId: String): Boolean

Checks whether a given style layer exists.

styleSourceExists

abstract fun styleSourceExists(@NonNull() sourceId: String): Boolean

Checks whether a given style source exists.

subscribe

abstract fun subscribe(@NonNull() observer: Observer, @NonNull() events: List<String>)

Subscribes an `observer` to a provided array of event types.The `observable` will hold a strong reference to an `observer` instance, therefore,in order to stop receiving notifications, caller must call `unsubscribe` with an`observer` instance used for an initial subscription.

unsubscribe

abstract fun unsubscribe(@NonNull() observer: Observer)

Unsubscribes an `observer` from all events.

abstract fun unsubscribe(@NonNull() observer: Observer, @NonNull() events: List<String>)

Unsubscribes an `observer` from a provided array of event types.

updateStyleImageSourceImage

abstract fun updateStyleImageSourceImage(@NonNull() sourceId: String, @NonNull() image: Image): Expected<String, None>

Updates the image of an [image style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources-image).